home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / 2sf4sre.zip / 2SF4SRE.DOC next >
Text File  |  1992-11-28  |  9KB  |  262 lines
  1.  
  2.  
  3.  
  4.                                     2SF4SRE
  5.                             (C) 1992 by Robin Duffy
  6.                               All rights reserved
  7.  
  8.           This package contains two useful utilities for using Solar Realms
  9.     with Spitfire. SF2SRE is a utility to quickly convert SFDOORS.DAT into
  10.     DOORFILE.SR for Solar Realms, and LIMITSRE will allow you to run
  11.     multiple games of SRE while limiting callers to playing just one game.
  12.  
  13.           This package is distributed as SHAREWARE, meaning you are free to
  14.     try these programs on a trial basis. You are encouraged to give this
  15.     package to your friends and upload it on your favorite BBS. If you
  16.     continue to use either of these programs after a reasonable time, you
  17.     should register your copies. See the included REGISTER.DOC for more
  18.     registration information.
  19.  
  20.      ==========================  SF2SRE.COM  ==============================
  21.  
  22.           SF2SRE.COM will create the player file for SRE while allowing
  23.     somce degree of control over the conversion process. To install SF2SRE,
  24.     simply copy the file SF2SRE to your Solar Realms program directory.
  25.     Command line syntax of SF2SRE is:
  26.  
  27.                                SF2SRE [options]
  28.  
  29.           where options is one or more of the following command line
  30.      switches:
  31.  
  32.                       /I - Do not force IBM character set
  33.                       /B - Use DTE rate instead of DCE rate
  34.                       /T - Ignore time limit
  35.  
  36.           Normally SF2SRE will tell SRE to use the IBM charater set. Using
  37.     the /I option will instead tell SRE that this option is unknown,
  38.     forcing it to use standard characters. The /B option will report the
  39.     max baud rate of your BBS to SRE, instead of the default of the
  40.     caller's baud rate. /T will set the time limit to -1, which tells SRE
  41.     not to be concerned with time. The default is to report the caller's
  42.     time left.
  43.  
  44.           Place SF2SRE in your Spitfire batch file in place of SRDOOR.EXE
  45.     like this, assuming that SRE is set up as door A:
  46.  
  47.           :DOOR_A
  48.           CD DOOR_A
  49.           COPY ..\SFDOORS.DAT > NUL
  50.           SF2SRE
  51.           SRE
  52.           DEL SFDOORS.DAT
  53.           DEL DOORFILE.SR
  54.           CD..
  55.           GOTO LOOP
  56.  
  57.           SF2SRE will read the appropriate lines from SFDOORS.DAT and
  58.     create DOORFILE.SR. If you do not delete DOORFILE.SR as part of your
  59.     batch file, then SF2SRE will overwrite the old copy.
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.           For reference, here is the format of DOORFILE.SR and the lines
  70.     from SFDOORS.DAT used:
  71.  
  72.      DOORFILE.SR                   COMMENTS
  73.      -------------------------------------------------------------------
  74.      User Name                     SFDOORS.DAT line 2
  75.      ANSI?                         SFDOORS.DAT line 10, TRUE or FALSE
  76.      IBM Character set?            Set to 1, if /I then set to -1
  77.      Screen lines                  Set to -1, SRE defaults to 25
  78.      Baud Rate                     SFDOORS.DAT line 5, if /B then line 20
  79.      COM Port                      SFDOORS.DAT line 6
  80.      Time Limit                    SFDOORS.DAT line 7, if /T then set -1
  81.  
  82.      ========================  LIMITSRE.COM  =============================
  83.  
  84.           LIMITSRE.COM is a handy utility that will limit player access to
  85.     Solar Realms when you are running multiple games. One of the main
  86.     reasons for running multiple games is to allow more players access to
  87.     the game. This utility will enforce that ideal for you.
  88.  
  89.           The program operates by getting the caller's name from
  90.     SFDOORS.DAT, then inspecting each game's USER.SR file to determine if
  91.     the caller is playing somewhere else. If he is, then a display file is
  92.     shown to the caller and the program exits with the DOS ERRORLEVEL set
  93.     to a value of 50. Your batch file detects this condition and skips the
  94.     call to SRE. LIMITSRE also handles multi-node operation.
  95.  
  96.           To install the program, copy the file LIMITSRE.COM to your main
  97.     Spitfire directory. Configure the program by creating an ASCII file
  98.     named LIMITSRE.CFG in your Spitfire directory with the following
  99.     format:
  100.  
  101.           Line 1: COM port
  102.           Line 2: Display file name
  103.           Line 3: Path to game one
  104.           Line 4: Path to game two
  105.           .
  106.           .
  107.           Line x: Path to game x
  108.  
  109.     Each line is described below.
  110.  
  111.      Line One: COM Port
  112.  
  113.           LIMITSRE supports standard COM ports 1 - 4 for display of the
  114.     copyright notice and the denial display file. Here are the I/O bases
  115.     and IRQs currently supported:
  116.  
  117.           Name      Port      IRQ
  118.           -----------------------
  119.           COM 1     03F8h      4
  120.           COM 2     02F8h      3
  121.           COM 3     03E8h      4
  122.           COM 4     02E8h      3
  123.  
  124.      As yet, non-standard COM port arrangements are not supported.
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.      Line Two: Display File Name
  135.  
  136.           When LIMITSRE denies access to a caller, it looks for a display
  137.     file to show. This name is the path and filename of the display file to
  138.     show, minus the extension. For ANSI callers the extension of .CLR will
  139.     be searched for and used first, if it exists.  If the caller is not
  140.     using ANSI or the .CLR file cannot be found, then LIMITSRE will search
  141.     for the display file with an extension of .BBS.  If neither display
  142.     file can be found, a default message will be shown to the caller.
  143.  
  144.      Line 3 to Line x: Paths to each game
  145.  
  146.           Every line that follows the first two are the actual game
  147.     directories for your SRE games. The program can handle up to 1200
  148.     different games, suitable for most applications. The path name can be a
  149.     relative or absolute path. Place one path per line. You may order the
  150.     games in any manner you see fit, but LIMITSRE will assume the first
  151.     path given is game #1, the second is game #2, and so on. This is
  152.     important to remember when modifying your SF.BAT file.
  153.  
  154.           The next step in the installation is to include LIMITSRE in your
  155.     batch file. Place LIMITSRE after each SRE door label with a command
  156.     line parameter like this:
  157.  
  158.           :DOOR_A
  159.           LIMITSRE gamenumner
  160.           IF ERRORLEVEL 50 GOTO LOOP
  161.  
  162.      Gamenumber above is the number of this particular game of SRE.
  163.     LIMITSRE uses this parameter to know which game it should skip while
  164.     checking each USER.SR file.
  165.  
  166.           As an example installation, let's assume you are running four
  167.     games of Solar Realms in directories C:\SF\DOOR_A, DOOR_B, DOOR_C, and
  168.     DOOR_D. You have created two display files named NOSRE.CLR and
  169.     NOSRE.BBS and placed them in your display directory. Your modem for
  170.     this node is on COM 1. Your installation steps are:
  171.  
  172.     1.    Place LIMITSRE.COM in your C:\SF directory.
  173.  
  174.     2.    Create a text file named LIMITSRE.CFG and place it in C:\SF
  175.     directory. Its contents are:
  176.  
  177.           1
  178.           C:\SF\DISPLAY\NOSRE
  179.           C:\SF\DOOR_A
  180.           C:\SF\DOOR_B
  181.           C:\SF\DOOR_C
  182.           C:\SF\DOOR_D
  183.  
  184.     Please note that LIMITSRE will assume DOOR_A is game one, DOOR_B is
  185.     game 2, and so on.
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.     3.    Edit your SF.BAT file so it looks something like this:
  200.  
  201.           :DOOR_A:
  202.           LIMITSRE 1
  203.           IF ERRORLEVEL 50 GOTO LOOP
  204.           CD DOOR_A
  205.           COPY ..\SFDOORS.DAT >NUL
  206.           SF2SRE
  207.           SRE
  208.           CD..
  209.           GOTO LOOP
  210.           :DOOR_B
  211.           LIMITSRE 2
  212.           IF ERRORLEVEL 50 GOTO LOOP
  213.           .
  214.           .
  215.           GOTO LOOP
  216.           :DOOR_C
  217.           LIMITSRE 3
  218.           IF ERRORLEVEL 50 GOTO LOOP
  219.           .
  220.           .
  221.           GOTO LOOP
  222.           :DOOR_D
  223.           LIMITSRE 4
  224.           IF ERRORLEVEL 50 GOTO LOOP
  225.           .
  226.           .
  227.  
  228.           That is all there is to the installation. Now when a caller opens
  229.     any Solar Realm game, he will see a message stating "Checking other
  230.     games, please wait...". LIMITSRE will quickly scan all SRE games except
  231.     the one given on the command line. If the caller is in another game, he
  232.     will be shown the display file you create and returned to the BBS.
  233.     Otherwise he drops right through to the game.
  234.  
  235.        ======================= IN CONCLUSION ==========================
  236.  
  237.           If you have any questions or comments regarding either program in
  238.     this package, please feel free to contact me. I will be happy to assist
  239.     you in any way I can. I may be reached at the address listed in
  240.     REGISTER.DOC, or you may call my BBS at (606) 561-5766 300-14.4K baud
  241.     v.32/v.42bis 24 hours daily.
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.